<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Data Set Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">DataSet Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Parent of simple data set and joint data set.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Data Set</td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportElement.html">ReportElement</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>Data Sets</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-cachedMetaData">cachedMetaData</a></dt>
<dd>Cached derived data attributes of a data set.</dd>
<dt><a href="#Property-columnHints">columnHints</a></dt>
<dd>Defines the report-related data attributes of the result set�s columns.</dd>
<dt><a href="#Property-computedColumns">computedColumns</a></dt>
<dd>User-defined columns in the result set.</dd>
<dt><a href="#Property-filter">filter</a></dt>
<dd>An optional set of filters to apply to the result set before any other data transforms.</dd>
<dt><a href="#Property-needsCache">needsCache</a></dt>
<dd></dd>
<dt><a href="#Property-parameters">parameters</a></dt>
<dd>Defines the data access attributes of the list of input and/or output parameters.</dd>
<dt><a href="#Property-resultSetHints">resultSetHints</a></dt>
<dd></dd>
<dt><a href="#Property-rowFetchLimit">rowFetchLimit</a></dt>
<dd></dd>
<dt><a href="#Property-sortHints">sortHints</a></dt>
<dd>List of sort hints which support row ordering.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p></p></div>
<h1>Property Detail</h1>

<h2><a name="Property-cachedMetaData">cachedMetaData Property</a></h2>

<p class="section-text">Cached derived data attributes of a data set.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../structs/CachedMetaData.html">CachedMetaData</a> Structure</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Cached metadata</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Defines the cached derived data attributes of a data 
set. The BIRT designer uses the cached 
information until the user initiates refresh and reconciles with the latest 
derived data attributes provided by the connected data source. This 
property is used during report design time only; its content is maintained by 
the BIRT designer tool.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>CachedMetaData</span> structure</p></div>

<hr>
<h2><a name="Property-columnHints">columnHints Property</a></h2>

<p class="section-text">Defines the report-related data attributes of the result set�s columns.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ColumnHint.html">ColumnHint</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Column hints</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>In BIRT, a result set column can be defined with an 
alias.&nbsp; Aliases are useful in cases where a column name is awkward, or is used 
by multiple columns in a result set.</p>

<p>BIRT reports provide a rich viewing experience. The user 
can search the report, extract data to a file, export data to an OLAP system, 
and more. Such operations work on the actual data set�s result set instead of on 
the presentation of the data. Column hints let the report developer customize 
the search and data extract experience.</p>

<p>The column hint element provides a number of &quot;hints&quot; 
about result set columns. The hints override BIRT defaults for how columns are 
handled during viewing. Hints can be provided for both retrieved and computed 
columns.</p>

<p>Column hints are keyed to the data set�s primary result 
set using names. The user must understand how to keep the hints in sync with the 
data set when either the data set definition, or underlying data source, 
changes.</p>

<p>BIRT uses the column hints in the following cases:</p>

<ul>
<li>The report references a column using the alias defined in the column hint.</li>
<li>The report references a column (retrieved or computed) that is also referenced by the column hint.</li>
<li>The column hint has the Export attribute set to &quot;always&quot;.</li>
</ul>

<p>In each case, BIRT checks whether the data set provides 
the requested column. If so, it continues processing the report.&nbsp; If not, it 
issues a fatal runtime error.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>ColumnHint</span> structure</p></div>

<hr>
<h2><a name="Property-computedColumns">computedColumns Property</a></h2>

<p class="section-text">User-defined columns in the result set.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ComputedColumn.html">ComputedColumn</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Computed columns</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A computed column is a user-defined column produced as an 
expression of other columns within the data set�s primary result set. It is not 
of the columns retrieved directly from the underlying data provider.</p></div>

<hr>
<h2><a name="Property-filter">filter Property</a></h2>

<p class="section-text">An optional set of filters to apply to the result set before any other data transforms.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/FilterCondition.html">FilterCondition</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Filter</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>An optional set of filters that apply to the data set�s 
primary result set.&nbsp; A data set�s filter is applied to each row of the retrieved 
result set before any other data transforms.&nbsp; The filter expression should thus 
not contain any aggregation functions.&nbsp; It usually references at least one 
column from a data row, and may also reference a report parameter or other 
scripting variable.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>Filter Criteria</span> structure</p>
<p>Listing <code>filter</code> property</p>
<p>ListingGroup <code>filter</code> 
property</p></div>

<hr>
<h2><a name="Property-needsCache">needsCache Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.3</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Needs cache for data-engine</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-parameters">parameters Property</a></h2>

<p class="section-text">Defines the data access attributes of the list of input and/or output parameters.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/DataSetParam.html">DataSetParam</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Data set parameters</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Many data sets allow parameters, which can be of input and/or output modes. For some, the user must define the parameters as part of the data set definition. For other data sets, the driver itself can provide the set of parameter definitions from the information available in a data set query. In the latter case, parameter definitions are derived data and <i>are not</i> stored in the parameter definition.</p>
<p>Some drivers refer to a parameter by position. Others can refer to a parameter by name. Also, for some data sets, the data set definition can omit parameter definitions for optional parameters not used within the report. &nbsp;Not all parameter properties are required. If a property is omitted. BIRT assumes that the data set implementation can provide it at run time. If the driver cannot provide the information, then a runtime error occurs.&nbsp;This is an optional list of data set parameter definitions, used only when the underlying data provider cannot provide this information.&nbsp;When contradicting meta-data are found between those provided dynamically by a data provider and&nbsp;those specified in a data set definition, the data provider&iuml;&iquest;&frac12;s meta-data takes precedence.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>ComputedColumn</span> structure</p></div>

<hr>
<h2><a name="Property-resultSetHints">resultSetHints Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ResultSetColumn.html">ResultSetColumn</a> Structures</td></tr>
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Result set hints</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-rowFetchLimit">rowFetchLimit Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Max number of rows to fetch from data set</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-sortHints">sortHints Property</a></h2>

<p class="section-text">List of sort hints which support row ordering.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/SortHint.html">SortHint</a> Structures</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort hints</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>List of sort hints which support row ordering.Sort hint can be mapped to ODA corresponding values.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>SortHint</span> structure</p></div>
</body>
</html>
